<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcluserevent.cpp -->
  <title>QCLUserEvent Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/style.css" />
  <script src="scripts/jquery.js" type="text/javascript"></script>
  <script src="scripts/functions.js" type="text/javascript"></script>
  <script src="./scripts/superfish.js" type="text/javascript"></script>
  <link rel="stylesheet" type="text/css" href="style/superfish.css" />  <script src="./scripts/narrow.js" type="text/javascript"></script>
  <link rel="stylesheet" type="text/css" href="style/narrow.css" />
  <!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="150"><img src="images/qt-logo.png" align="left" border="0" />&nbsp;&nbsp;<img src="images/qtopencl-logo.png" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"> <a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="qtopencl-all-classes.html"><font color="#004faf">All Classes</font></a></td>
</table>              <li><a href="modules.html">Modules</a></li>              <li>QtCL</li>
              <li>QCLUserEvent</li>
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QCLUserEvent Class Reference</h1>
<!-- $$$QCLUserEvent-brief -->
<p>The QCLUserEvent class represents OpenCL 1.1 user events. <a href="#details">More...</a></p>
<!-- @@@QCLUserEvent -->
<pre class="highlightedCode brush: cpp">    #include &lt;QCLUserEvent&gt;</pre><p>Inherits <a href="qclevent.html">QCLEvent</a>.</p>
<p>This class was introduced in QtOpenCL 4.7.</p>
<ul>
<li><a href="qcluserevent-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#QCLUserEvent">QCLUserEvent</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#QCLUserEvent-2">QCLUserEvent</a></b> ( cl_event <i>id</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#QCLUserEvent-3">QCLUserEvent</a></b> ( const QCLEvent &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#setFinished">setFinished</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#setStatus">setStatus</a></b> ( cl_int <i>status</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QCLUserEvent &amp; </td><td class="memItemRight bottomAlign"><b><a href="qcluserevent.html#operator-eq">operator=</a></b> ( const QCLEvent &amp; <i>other</i> )</td></tr>
</table>
<ul>
<li class="fn">19 public functions inherited from <a href="qclevent.html#public-functions">QCLEvent</a></li>
</ul>
<a name="details"></a>
<!-- $$$QCLUserEvent-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCLUserEvent class represents OpenCL 1.1 user events.</p>
<p>User events are a feature of OpenCL 1.1 which allows an application to insert a marker into the command queue. Commands that depend upon the marker will not be executed until the application triggers the user event with <a href="qcluserevent.html#setFinished">setFinished</a>().</p>
<p>User events are constructed with <a href="qclcontext.html#createUserEvent">QCLContext::createUserEvent</a>(), which will return null if the OpenCL implementation does not support OpenCL 1.1&#x2e;</p>
</div>
<p>See also <a href="qclevent.html">QCLEvent</a> and <a href="qclcontext.html#createUserEvent">QCLContext::createUserEvent</a>().</p>
<!-- @@@QCLUserEvent -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCLUserEvent[overload1]$$$QCLUserEvent -->
<h3 class="fn"><a name="QCLUserEvent"></a>QCLUserEvent::QCLUserEvent ()</h3>
<p>Constructs a null user event.</p>
<!-- @@@QCLUserEvent -->
<!-- $$$QCLUserEvent$$$QCLUserEventcl_event -->
<h3 class="fn"><a name="QCLUserEvent-2"></a>QCLUserEvent::QCLUserEvent ( cl_event <i>id</i> )</h3>
<p>Constructs an OpenCL event object from the native identifier <i>id</i>. This class takes over ownership of <i>id</i> and will release it in the destructor.</p>
<p>If <i>id</i> is not a user event, then the newly constructed event will be set to null, and <i>id</i> will be released.</p>
<!-- @@@QCLUserEvent -->
<!-- $$$QCLUserEvent$$$QCLUserEventconstQCLEvent& -->
<h3 class="fn"><a name="QCLUserEvent-3"></a>QCLUserEvent::QCLUserEvent ( const <a href="qclevent.html">QCLEvent</a> &amp; <i>other</i> )</h3>
<p>Constructs a copy of <i>other</i>. The <tt>clRetainEvent()</tt> function will be called to update the reference count on <a href="qclevent.html#eventId">eventId</a>().</p>
<p>If <i>other</i> is not a user event, then the newly constructed event will be set to null.</p>
<!-- @@@QCLUserEvent -->
<!-- $$$setFinished[overload1]$$$setFinished -->
<h3 class="fn"><a name="setFinished"></a>void QCLUserEvent::setFinished ()</h3>
<p>Sets this user event to the finished state. Any queued commands that depend upon this event can now proceed.</p>
<p>See also <a href="qcluserevent.html#setStatus">setStatus</a>().</p>
<!-- @@@setFinished -->
<!-- $$$setStatus[overload1]$$$setStatuscl_int -->
<h3 class="fn"><a name="setStatus"></a>void QCLUserEvent::setStatus ( cl_int <i>status</i> )</h3>
<p>Sets the <i>status</i> of this user event. The <i>status</i> should be either <tt>CL_COMPLETE</tt> or a negative OpenCL error code.</p>
<p>See also <a href="qcluserevent.html#setFinished">setFinished</a>().</p>
<!-- @@@setStatus -->
<!-- $$$operator=[overload1]$$$operator=constQCLEvent& -->
<h3 class="fn"><a name="operator-eq"></a>QCLUserEvent &amp; QCLUserEvent::operator= ( const <a href="qclevent.html">QCLEvent</a> &amp; <i>other</i> )</h3>
<p>Assigns <i>other</i> to this OpenCL event object. The current <a href="qclevent.html#eventId">eventId</a>() will be released with <tt>clReleaseEvent()</tt>, and the new <a href="qclevent.html#eventId">eventId</a>() will be retained with <tt>clRetainEvent()</tt>.</p>
<p>If <i>other</i> is not a user event, then this event will be set to null.</p>
<!-- @@@operator= -->
</div>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright &copy; 2010 Nokia Corporation</td>
<td align="right">QtOpenCL Documentation</td>
</tr></table></div></address>  <script src="scripts/functions.js" type="text/javascript"></script>
  <script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-4457116-5']);
  _gaq.push(['_trackPageview']);
  (function() {
  var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  })();
  </script>
</body>
</html>
